home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 1 / Meeting Pearls Vol 1 (1994).iso / installed_progs / comm / ums / developer.lha / Developer / arexx / RexxUMS.doc next >
Encoding:
Text File  |  1993-09-30  |  5.2 KB  |  131 lines
  1.                  ///////////////////////////////////////////
  2.                 ///    UMS - Universal Message System   ///
  3.                /// Documentation of the ARexx Inteface ///
  4.               ///////////////////////////////////////////
  5.  
  6. ums.library is now a ARexx function library.  The query function is at
  7. offset -210.  Use addlib() to RXLIB install it in the global library list
  8. of ARexx.  
  9.  
  10. Please refer to ums' autodoc to get a general understandig of
  11. the functions. This file only documents the bare interface.
  12.  
  13. "UmsConsts.rexx" defines all constants concering UMS.  "UMS-Sekeleton.rexx"
  14. is a skeleton script which may be used as a starting point for other
  15. scripts.  Also four litte demo scripts are supplied.  Study them carefully.
  16.  
  17.  
  18. Datatypes:
  19. ==========
  20.  
  21.   string  - a string (e.g. "Hello!")
  22.   account - abstract handle returned by Login()
  23.   number  - a cardinal number
  24.   kind    - kind of ums flags ("User"="U" / "Global"="G" / "Local"="L")
  25.   boolean - "0" (FALSE) or "1" (TRUE)
  26.   flags   - a bitfield (e.g. '00110111 10101001 10100110 10100101'b)
  27.   stem    - a stem variable used to hold all fields of a message
  28.  
  29.  
  30. Functions
  31. =========
  32.  
  33.   number = UMSLogin (user: string, password: string[, server: string])
  34.   UMSLogout (account: account)
  35.  
  36. These two functions should be easy to understand.
  37.  
  38.   number = UMSErrNum (account: account)
  39.   string = UMSErrTxt (account: account)
  40.  
  41. Use these functions to find out if an error and it's reason.
  42.  
  43.   FlushUMS ()
  44.   QuitUMS ()
  45.   number = CleanUMS ()
  46.  
  47. These function are used to signal the default server.
  48.  
  49.   LogUMS (account: account, level: number, text: string)
  50.  
  51. Writes a log message to ums' logfile.
  52.  
  53.   number = WriteUMSMsg (account: account, fields: stem)
  54.  
  55. This one writes a new message to the message base. The field of the message
  56. must be in the stem. The meaning of the fields numbered from 0 to 127 is
  57. defined in "UMSConts.rexx". There are some special fields, too: MSGNUM,
  58. HARDLINK, SOFTLINK, CHAINUP, MSGDATE, HDRFILL, TXTFILL, MSGDATE, AUTOBOUNCE,
  59. NOUPDATE, HIDE. Please take a look at ums.doc to find put their meaning.
  60.  
  61.   ExportedUMSMsg  (account: account, message: number)
  62.   UMSCannotExport (account: account, message: number, error: string)
  63.  
  64. These are used by exportes. See ums.doc.
  65.  
  66.   boolean = DeleteUMSMsg (account: account, message: number)
  67.  
  68. Obvious.
  69.  
  70.   booelan = ReadUMSMsgAll    (account: account, message: number, fields: stem[, noupdate: boolean])
  71.   booelan = ReadUMSMsgHeader (account: account, message: number, fields: stem[, noupdate: boolean])
  72.   booelan = ReadUMSMsgField  (account: account, message: number, fields: stem, field: number[, noupdate: boolean])
  73.  
  74. These function read a message from the message base and put it's fields
  75. into the stem. The first function reads all fields, the second just header
  76. fields and the last only one field. _IMPORTANT_NOTE_: These functions do
  77. not drop empty fields. Please ensure that you drop the stem before calling
  78. one of those funktions!
  79.  
  80.   booelan = ReadUMSMsgInfo   (account: account, message: number, info: stem)
  81.  
  82. These reads the binary data associated with a message. It is put into the
  83. following fields of the stem: HDRLEN, TXTLEN, DATE, UP, DN, LT, RT, GLOBALSTAT,
  84. USERSTAT, LOGINSTAT, SOFTLINK, HARDLINK
  85.  
  86.   number = UMSSelectFlags (account: account, [kind: kind, set: flags, unset: flags, start: nuber, stop: number, kind: kind, mask: flags, match: flags])
  87.  
  88. Sets all "set" flags and clears all "clear" flags for all messages between
  89. "start" and "stop" which fulfills bitand(status,"mask")="match".
  90.  
  91.   number = UMSSelectField (account: account, [kind: kind, set: flags, unset: flags, start: nuber, stop: number,] field: number, string: string[, quick: BOOLEAN])
  92.  
  93. Selects the message(s) if a certain field has a certain value. "quick"
  94. enables CRC checking which is fast.
  95.  
  96.   number = UMSSelectDate  (account: account, [kind: kind, set: flags, unset: flags, start: nuber, stop: number,] date: number)
  97.  
  98. Selects Messages younger than "date".
  99.  
  100.   number = UMSSelectTree  (account: account, [kind: kind, set: flags, unset: flags,] message: number[, sub: BOOLEAN])
  101.  
  102. All messages in the reply tree will be selected.
  103.  
  104.   number = UMSSelectMsg   (account: account, [kind: kind, set: flags, unset: flags,] message: number)
  105.  
  106. Selects one message by number.
  107.  
  108.   number = UMSSearchFlags (account: account, [kind: kind, mask: flags, match: flags,] last: number)
  109.  
  110. Finds the next message starting with "last" with fullfills
  111. bitand(status,"mask")="match".
  112.  
  113.   number = UMSSearchField   (account: account, field: number, string: string,  last: number[, direction: number, quick: boolean])
  114.   number = UMSSearchPattern (account: account, field: number, pattern: string, last: number[, direction: number])
  115.  
  116. Search for the next message fith a certain field.
  117.  
  118.   string = ReadUMSConfig (account: account, name: string[, user: string, globalonly: boolean])
  119.   string = ReadUMSConfigUserName (account: account, aka: string)
  120.   string = NextUMSVar (account: account, last: string, user: string[, globalonly: boolean])
  121.  
  122. These are used to get configuration variables from ums.config.
  123.  
  124.   boolean = WriteUMSConfig (account: account, name: string, data: string[, user: string, global: boolean])
  125.  
  126. Wite a variable to ums.config.
  127.  
  128.   boolean = DumpUMSConfig (account: account, file: string)
  129.  
  130. Dump the current configuration to a file.
  131.